Skip to content

docs(readme): polish OSS contributor paths#424

Merged
moncher-dev merged 1 commit into
mainfrom
feat/422-readme-oss-polish
Jul 2, 2026
Merged

docs(readme): polish OSS contributor paths#424
moncher-dev merged 1 commit into
mainfrom
feat/422-readme-oss-polish

Conversation

@moncher-dev

Copy link
Copy Markdown
Collaborator

TL;DR

Polishes the README so first-time OSS users can immediately see project health, license, contribution, support, and security paths near the top of the repository page.

변경 지점 다이어그램

README.md
├─ top badges: CI, npm, Node.js 24+, MIT, PRs welcome, Code of Conduct
├─ intro note: OSS contribution, support bundle, security reporting guidance
└─ Community and security: clearer links to contributing, security, conduct, license

여기부터 보세요

  • README.md top section for badges and the contributor/support note.
  • README.md Community and security section for the preserved and lightly improved community links.

위험 & 롤백

  • Risk is low: documentation-only change with no runtime behavior impact.
  • Rollback is a single README revert if wording or badge selection needs to change.

변경 파일

  • README.md — add OSS-facing badges and early contributor/support guidance, then clarify bottom community links.

Evidence

  • pnpm install --frozen-lockfile — installed dependencies from the existing lockfile after initial lint showed missing node_modules.
  • pnpm lint — pass.
  • pnpm test — pass.
  • pnpm typecheck — pass.
  • pnpm build — pass.
  • pnpm exec prettier --check README.md — pass.
  • npm view @gh-symphony/cli version --silent — package resolves as 0.4.7.
  • gh api repos/hojinzs/github-symphony/actions/workflows/ci.yml --jq '.name + " " + .state'CI active.
  • Direct checks confirmed local links exist for CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, LICENSE, and .github/workflows/ci.yml.
  • Direct curl -L --fail checks passed for all added shields.io badge URLs.
  • Note: full-repo pnpm format still fails on pre-existing formatting drift in unrelated files; README.md itself passes Prettier.

Issues — Closed #422

Closes #422

머지 후/사람 확인

  • Confirm the README wording and badge set fit the repository's desired OSS presentation.

@moncher-dev moncher-dev marked this pull request as ready for review July 2, 2026 04:57
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 39.3% 28888 / 73504
🔵 Statements 39.3% 28888 / 73504
🔵 Functions 71.73% 1411 / 1967
🔵 Branches 76.86% 5977 / 7776
File CoverageNo changed files found.
Generated in workflow #317 for commit 1d304e1 by the Vitest Coverage Report Action

@hojinzs hojinzs left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Watchdog review result: approve.

Evidence bundle: https://evidence-browser.dev0.daniworks.kr/w/github-symphony/b/project14-pr-424-20260702-052616

Scope reviewed:

  • README-only OSS contributor and support-discoverability polish.
  • Verified new links point to existing repository docs.

Smoke tests run:

  • git diff --check origin/main...HEAD — passed
  • referenced docs exist (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, LICENSE) — passed
  • pnpm exec prettier --check README.md — passed

Blocking findings: none.

Note: Claude Code review was attempted in read/test-only mode but failed authentication (401), so this approval is based on watchdog inspection plus the smoke tests above.

@moncher-dev moncher-dev merged commit d7e2172 into main Jul 2, 2026
2 checks passed
@moncher-dev moncher-dev deleted the feat/422-readme-oss-polish branch July 2, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Polish README for OSS contributors and support discoverability

2 participants